SCHED: GetTaskInfoJson
Format
SCHED / GetTaskInfoJson '<TaskName>' '<FileName>'
Description
The SCHED GetTaskInfoJson Connect command returns all of the attributes of the task specified by the <TaskName> parameter in JSON format. The output will be formatted as a JSON array, even if information on only a single task is requested. Each element in this JSON array maps to a single task.
GetTaskInfoJson vs. GetTaskInfo
The choice of command will depend on use case.
SCHED GetTaskInfoJson provides output in a commonly used format that is easy to parse. This command is preferred if schedule information will be further processed.
SCHED GetTaskInfo provides output that is difficult to parse but easy to understand. This command is preferred if no further processing is required.
Parameters
- TaskName: The parameter is a string of text in single quotes of a comma delimited list of tasks. Task names should not be in quotes. Supports the use of wildcards.
- FileName: The parameter is a string of text in single quotes of the absolute path file name. Empty string is allowed if the command does not write out to a file.
Examples
Finds out the values of all the attributes of the 'Management Report(1)' task in the active schedule and saves it
to the file "TaskReport.json" located at "C:\Outputs\"
SCHED / GetTaskInfoJson
'Management Report(1)' 'C:\Outputs\TaskReport.json'
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / GetTaskInfoJson |
| <TaskName> | 'Management Report(1)' |
| <FileName> | 'C:\Outputs\TaskReport.Json' |
Return Message
Connect returns a JSON formatted message that contains all of the attribute data for the task.
The following JSON file contains sample output of the above command.
Group Membership
This command belongs to the following group(s):
Version
12.0
